/*
 * Copyright 2009 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.beepmystuff;

import org.apache.http.client.methods.HttpUriRequest;

/**
 * An abstraction for HTTP requests made by the BMS API.
 */
public interface BmsHttpClient {
  /**
   * Makes an HTTP request using our client, and returns the body of the
   * response.
   * 
   * @throws BmsTransportException if the request was unsuccessful (i.e. the
   *     HTTP request could not be made).
   */
  byte[] getResponseBody(HttpUriRequest request) throws BmsTransportException;

  /**
   * Makes an HTTP request using our client, and returns the body of the
   * response as a string.
   * 
   * <p>Note: assumes that the response is delivered in UTF-8 encoding.
   * 
   * @throws BmsTransportException if the request was unsuccessful (i.e. the
   *     HTTP request could not be made).
   */
  String getResponseBodyAsString(HttpUriRequest request)
      throws BmsTransportException;

}
